IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / X11 / xauth.z / xauth

Wrap

Text File | 2002-10-03 | 15.9 KB | 331 lines

XXXXAAAAUUUUTTTTHHHH((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666)))) XXXXAAAAUUUUTTTTHHHH((((1111)))) NNNNAAAAMMMMEEEE xauth - X authority file utility SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS xxxxaaaauuuutttthhhh [ ----ffff _a_u_t_h_f_i_l_e ] [ ----vvvvqqqqiiiibbbb ] [ _c_o_m_m_a_n_d _a_r_g ... ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The _x_a_u_t_h program is used to edit and display the authorization information used in connecting to the X server. This program is usually used to extract authorization records from one machine and merge them in on another (as is the case when using remote logins or granting access to other users). Commands (described below) may be entered interactively, on the _x_a_u_t_h command line, or in scripts. Note that this program does nnnnooootttt contact the X server except when the generate command is used. Normally _x_a_u_t_h is not used to create the authority file entry in the first place; _x_d_m does that. OOOOPPPPTTTTIIIIOOOONNNNSSSS The following options may be used with _x_a_u_t_h. They may be given individually (e.g., -_q -_i) or may combined (e.g., -_q_i). ----ffff _a_u_t_h_f_i_l_e This option specifies the name of the authority file to use. By default, _x_a_u_t_h will use the file specified by the XAUTHORITY environment variable or ._X_a_u_t_h_o_r_i_t_y in the user's home directory. ----qqqq This option indicates that _x_a_u_t_h should operate quietly and not print unsolicited status messages. This is the default if an _x_a_u_t_h command is is given on the command line or if the standard output is not directed to a terminal. ----vvvv This option indicates that _x_a_u_t_h should operate verbosely and print status messages indicating the results of various operations (e.g., how many records have been read in or written out). This is the default if _x_a_u_t_h is reading commands from its standard input and its standard output is directed to a terminal. ----iiii This option indicates that _x_a_u_t_h should ignore any authority file locks. Normally, _x_a_u_t_h will refuse to read or edit any authority files that have been locked by other programs (usually _x_d_m or another _x_a_u_t_h). ----bbbb This option indicates that _x_a_u_t_h should attempt to break any authority file locks before proceeding. Page 1 (printed 10/3/02) XXXXAAAAUUUUTTTTHHHH((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666)))) XXXXAAAAUUUUTTTTHHHH((((1111)))) Use this option only to clean up stale locks. CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS The following commands may be used to manipulate authority files: aaaadddddddd _d_i_s_p_l_a_y_n_a_m_e _p_r_o_t_o_c_o_l_n_a_m_e _h_e_x_k_e_y An authorization entry for the indicated display using the given protocol and key data is added to the authorization file. The data is specified as an even-lengthed string of hexadecimal digits, each pair representing one octet. The first digit of each pair gives the most significant 4 bits of the octet, and the second digit of the pair gives the least significant 4 bits. For example, a 32 character hexkey would represent a 128-bit value. A protocol name consisting of just a single period is treated as an abbreviation for _M_I_T-_M_A_G_I_C-_C_O_O_K_I_E-_1. ggggeeeennnneeeerrrraaaatttteeee _d_i_s_p_l_a_y_n_a_m_e _p_r_o_t_o_c_o_l_n_a_m_e [ttttrrrruuuusssstttteeeedddd||||uuuunnnnttttrrrruuuusssstttteeeedddd] [ttttiiiimmmmeeeeoooouuuutttt _s_e_c_o_n_d_s] [ggggrrrroooouuuupppp _g_r_o_u_p-_i_d] [ddddaaaattttaaaa _h_e_x_d_a_t_a] This command is similar to add. The main difference is that instead of requiring the user to supply the key data, it connects to the server specified in _d_i_s_p_l_a_y_n_a_m_e and uses the SECURITY extension in order to get the key data to store in the authorization file. If the server cannot be contacted or if it does not support the SECURITY extension, the command fails. Otherwise, an authorization entry for the indicated display using the given protocol is added to the authorization file. A protocol name consisting of just a single period is treated as an abbreviation for _M_I_T-_M_A_G_I_C-_C_O_O_K_I_E-_1. If the ttttrrrruuuusssstttteeeedddd option is used, clients that connect using this authorization will have full run of the display, as usual. If uuuunnnnttttrrrruuuusssstttteeeedddd is used, clients that connect using this authorization will be considered untrusted and prevented from stealing or tampering with data belonging to trusted clients. See the SECURITY extension specification for full details on the restrictions imposed on untrusted clients. The default is uuuunnnnttttrrrruuuusssstttteeeedddd. The ttttiiiimmmmeeeeoooouuuutttt option specifies how long in seconds this authorization will be valid. If the authorization remains unused (no clients are connected with it) for longer than this time period, the server purges the authorization, and future attempts to connect using it will fail. Note that Page 2 (printed 10/3/02) XXXXAAAAUUUUTTTTHHHH((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666)))) XXXXAAAAUUUUTTTTHHHH((((1111)))) the purging done by the server does nnnnooootttt delete the authorization entry from the authorization file. The default timeout is 60 seconds. The ggggrrrroooouuuupppp option specifies the application group that clients connecting with this authorization should belong to. See the application group extension specification for more details. The default is to not belong to an application group. The ddddaaaattttaaaa option specifies data that the server should use to generate the authorization. Note that this is nnnnooootttt the same data that gets written to the authorization file. The interpretation of this data depends on the authorization protocol. The _h_e_x_d_a_t_a is in the same format as the _h_e_x_k_e_y described in the add command. The default is to send no data. [[[[nnnn]]]]eeeexxxxttttrrrraaaacccctttt _f_i_l_e_n_a_m_e _d_i_s_p_l_a_y_n_a_m_e... Authorization entries for each of the specified displays are written to the indicated file. If the _n_e_x_t_r_a_c_t command is used, the entries are written in a numeric format suitable for non-binary transmission (such as secure electronic mail). The extracted entries can be read back in using the _m_e_r_g_e and _n_m_e_r_g_e commands. If the filename consists of just a single dash, the entries will be written to the standard output. [[[[nnnn]]]]lllliiiisssstttt [_d_i_s_p_l_a_y_n_a_m_e...] Authorization entries for each of the specified displays (or all if no displays are named) are printed on the standard output. If the _n_l_i_s_t command is used, entries will be shown in the numeric format used by the _n_e_x_t_r_a_c_t command; otherwise, they are shown in a textual format. Key data is always displayed in the hexadecimal format given in the description of the _a_d_d command. [[[[nnnn]]]]mmmmeeeerrrrggggeeee [_f_i_l_e_n_a_m_e...] Authorization entries are read from the specified files and are merged into the authorization database, superceding any matching existing entries. If the _n_m_e_r_g_e command is used, the numeric format given in the description of the _e_x_t_r_a_c_t command is used. If a filename consists of just a single dash, the standard input will be read if it hasn't been read before. rrrreeeemmmmoooovvvveeee _d_i_s_p_l_a_y_n_a_m_e... Authorization entries matching the specified Page 3 (printed 10/3/02) XXXXAAAAUUUUTTTTHHHH((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666)))) XXXXAAAAUUUUTTTTHHHH((((1111)))) displays are removed from the authority file. ssssoooouuuurrrrcccceeee _f_i_l_e_n_a_m_e The specified file is treated as a script containing _x_a_u_t_h commands to execute. Blank lines and lines beginning with a sharp sign (#) are ignored. A single dash may be used to indicate the standard input, if it hasn't already been read. iiiinnnnffffoooo Information describing the authorization file, whether or not any changes have been made, and from where _x_a_u_t_h commands are being read is printed on the standard output. eeeexxxxiiiitttt If any modifications have been made, the authority file is written out (if allowed), and the program exits. An end of file is treated as an implicit _e_x_i_t command. qqqquuuuiiiitttt The program exits, ignoring any modifications. This may also be accomplished by pressing the interrupt character. hhhheeeellllpppp [[[[_s_t_r_i_n_g]]]] A description of all commands that begin with the given string (or all commands if no string is given) is printed on the standard output. ???? A short list of the valid commands is printed on the standard output. DDDDIIIISSSSPPPPLLLLAAAAYYYY NNNNAAAAMMMMEEEESSSS Display names for the _a_d_d, [_n]_e_x_t_r_a_c_t, [_n]_l_i_s_t, [_n]_m_e_r_g_e, and _r_e_m_o_v_e commands use the same format as the DISPLAY environment variable and the common -_d_i_s_p_l_a_y command line argument. Display-specific information (such as the screen number) is unnecessary and will be ignored. Same-machine connections (such as local-host sockets, shared memory, and the Internet Protocol hostname _l_o_c_a_l_h_o_s_t) are referred to as _h_o_s_t_n_a_m_e/unix:_d_i_s_p_l_a_y_n_u_m_b_e_r so that local entries for different machines may be stored in one authority file. EEEEXXXXAAAAMMMMPPPPLLLLEEEE The most common use for _x_a_u_t_h is to extract the entry for the current display, copy it to another machine, and merge it into the user's authority file on the remote machine: % xauth extract - $DISPLAY | rsh otherhost xauth merge - The following command contacts the server :0 to create an authorization using the MIT-MAGIC-COOKIE-1 protocol. Clients that connect with this authorization will be Page 4 (printed 10/3/02) XXXXAAAAUUUUTTTTHHHH((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666)))) XXXXAAAAUUUUTTTTHHHH((((1111)))) untrusted. % xauth generate :0 . EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT This _x_a_u_t_h program uses the following environment variables: XXXXAAAAUUUUTTTTHHHHOOOORRRRIIIITTTTYYYY to get the name of the authority file to use if the -_f option isn't used. HHHHOOOOMMMMEEEE to get the user's home directory if XAUTHORITY isn't defined. FFFFIIIILLLLEEEESSSS $_H_O_M_E/._X_a_u_t_h_o_r_i_t_y default authority file if XAUTHORITY isn't defined. BBBBUUUUGGGGSSSS Users that have unsecure networks should take care to use encrypted file transfer mechanisms to copy authorization entries between machines. Similarly, the _M_I_T-_M_A_G_I_C-_C_O_O_K_I_E-_1 protocol is not very useful in unsecure environments. Sites that are interested in additional security may need to use encrypted authorization mechanisms such as Kerberos. Spaces are currently not allowed in the protocol name. Quoting could be added for the truly perverse. AAAAUUUUTTTTHHHHOOOORRRR Jim Fulton, MIT X Consortium Page 5 (printed 10/3/02)